/*
 * mana (library)
 * Copyright (c) 2003 Shun Moriya <shun@mnu.sakura.ne.jp>
 *
 * The MIT License
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*!
 * @file
 * @brief	mana_arrayクラスに関するヘッダーファイル
 *
 * このファイルはmana_arrayクラスに関係するヘッダーファイルです。
 *
 * @author	Shun Moriya <shun@mnu.sakura.ne.jp>
 */

#if !defined(___MANA_ARRAY_H___)
#define ___MANA_ARRAY_H___

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif

#if !defined(___MANA_STREAM_H___)
#include "mana_stream.h"
#endif
#include <stddef.h>

/*!
 * @brief	クラス
 * mana_arrayクラスはフレームバッファを表しています。
 *
 * C++でいうところのメンバー変数ですが、C言語なので全てpublicになっています。
 * 操作用の関数を用意しているので、それらの関数を利用して操作してください。
 */
typedef struct mana_array
{
	void** handle;			/*!< @brief バッファ */
	size_t allocated_size;	/*!< @brief 確保済みサイズ */
	size_t used_size;		/*!< @brief 使用済みサイズ */
}mana_array;

/*! @brief mana_array オブジェクトの生成 */
extern mana_array* mana_array_create(const size_t size);

/*! @brief mana_array オブジェクトの破棄 */
extern void mana_array_destroy(mana_array* self);

/*! @brief mana_array オブジェクトのシリアライズ */
extern void mana_array_serialize(const mana_array* self, mana_stream* stream);

/*! @brief mana_array オブジェクトのデシリアライズ */
extern void mana_array_deserialize(mana_array* self, mana_stream* stream);

/*! @brief mana_array オブジェクトの初期化 */
extern void mana_array_initialize(mana_array* self, const size_t size);

/*! @brief mana_array オブジェクトの開放 */
extern void mana_array_finalize(mana_array* self);

/*! @brief 配列をクリア */
extern void mana_array_clear(mana_array* self);

/*! @brief 配列を参照 */
extern void* mana_array_get(const mana_array* self, const size_t index);

/*! @brief 配列にポインターを設定 */
extern void mana_array_set(mana_array* self, const size_t index, const void* pointer);

/*! @brief 配列のサイズを取得 */
extern size_t mana_array_get_size(const mana_array* self);

/*! @brief 配列にポインターを追加 */
extern void mana_array_append(mana_array* self, const void* pointer);

/*! @brief 配列のサイズを変更 */
extern void mana_array_resize(mana_array* self, const size_t size);

/*! @brief 配列を比較 */
extern int mana_array_compare(const mana_array* self, const mana_array* other);

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
}
#endif

#endif
